Click on OCR Text

Command Prototype

OCR.Click(objUiElement,objRect,sEngine,sAcessKey,sSecretKey,sText,iRule,iOccurrence,iButton,iType,iTimeOut,optionArgs)

Command Description

Use OCR to identify the specified text within a given window and simulate a mouse click if the text is found. Internet access is needed for this command

Parameter Description

Required Parameter

objUiElement--The UI element to search. If a string is passed, it is used as a feature string to search for the specified UIElement to click. If an UiElement is passed, the corresponding UI element is clicked

objRect--Area to recognize the specified string on. The program performs text recognition within the given area, formatted as { "x": 0, "y": 0, "width": 0, "height": 0}

sEngine--The OCR engine used.,

sAcessKey--Api key for the OCR service

sSecretKey--Secret key for the OCR service

sText--Search text to find the target element with

iRule--Rules to use when looking up the text

iOccurrence--Which search text match to click. If the search text appears multiple times, specify which occurrence to click. For example, if the text appears 4 times and you want to click the first match, input 1

iButton--Mouse button {left: left click, right: right click, middle: scroll wheel click}

iType--Click type (click: click, dbclick: double click, down: press, up: popUp}

iTimeOut--Maximum execution time (in milliseconds) of the activity. Throws a SelectorNotFoundException on timeout. Defaults to 10000

Optional Parameter

bContinueOnError--Whether to continue even if an error is thrown. This field only supports Boolean values (True, False). Defaults to False

iDelayAfter--Added delay (in milliseconds) after executing the activity. Defaults to 300

iDelayBefore--Added delay (in milliseconds) before executing the activity. Defaults to 200

bSetForeground--Whether to activate the target window before executing

sCursorPosition--Starting point of the cursor before adding OffsetX and OffsetY. Options: TopLeft, TopRight, BottomLeft, BottomRight, and Center

iCursorOffsetX--Horizontal displacement of the cursor position

iCursorOffsetY--Vertical displacement of the cursor position

sKeyModifiers--Extra keys to press at the same time the mouse action is triggered. Each key can be one of: Alt, Ctrl, Shift, Win

sSimulate--How to simulate the operation {default:background operation, simulate:simulated operation, message:system message}